home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / telecom / ezpro10.zip / EPROMISC.DOC < prev    next >
Text File  |  1996-10-01  |  22KB  |  559 lines
  1. EPROMISC is EZYPRO' utility function program. It contains many
  2. utility functions which are not stored within EZYPRO.EXE. 
  3.  
  4. EPROMISC is included to extended the functionality of EZYPRO
  5. to make it a complete utility package for the Ezycom sysop that
  6. not only provides BBS related functions, but also those for the
  7. mailers that the Ezycom sysops run. That is: it is a complete
  8. companion tool, not one of many, that you need to manage your
  9. Ezycomn BBS.
  10.  
  11. These functions are..
  12.  
  13.  
  14. /AGE            :       Create user age graph 
  15. /CLEAN          :       Clean up .ASC files for deleted areas 
  16. /DIRS           :       Create FILES.DIR list of FREQable dirs 
  17. /DOOR           :       Create Door usage graph screens 
  18. /ECHOLIST       :       Create message area echo lists 
  19. /FBCLEAN        :       Filebase cleanup. Delete redundant files 
  20. /FDA, /IMA      :       Generate Frontdoor or Intermail traffic reports 
  21. /FDSTRIP        :       Trim Intermail log file                          * 
  22. /FILDUMP        :       Dump file base info to text file 
  23. /IMSTRIP        :       Trim Intermail log file                          * 
  24. /INIT           :       Initialize history files 
  25. /LIST           :       Sends status notification messages to nodes 
  26. /MBCLEAN        :       Message area clean up. Remove redundant 
  27.             message areas                                    * 
  28. /MSGDUMP        :       Dump message base info to text file 
  29. /NEWS           :       Create ANS/ASC news files 
  30. /POINT          :       Create top 15 filepoints screen 
  31. /PURGE          :       Purge news articles 
  32. /SCAN           :       Generate filebase analysis report 
  33. /STATn          :       Generate statistics screens sorted by n, (n=1-5) 
  34. /TRIM           :       Trim log file to days specified on control file 
  35. /U=<user>       :       Create list of files uploaded by xxxx 
  36. /UPEXPORT       :        Export upload list to a text file 
  37. /VIEW           :       Display list of files uploaded from last /U
  38.  
  39. Functions listed with the * at the end are not currently
  40. available in this beta release of the package.
  41.  
  42. I am currently seeking to add functions to analyse Binkley and
  43. D'Bridge log files. If anyone has a log file for one of these
  44. mailers I'd be pleased to accept one and I'll include some
  45. D'Bridge and Binkley traffic and trim functions in the next
  46. release.
  47.  
  48. If you have other suggestions, comments or needs please feel
  49. free to send them to :
  50.  
  51. Phillip Morgan,                              Internet: pm@tbt.dialix.oz.au
  52. P.O. Box 449                                  Fidonet: 3:639/252               
  53. Croydon, Vic 3136                              Ezynet: 151:6133/101
  54.  
  55.  
  56. /AGE
  57.  
  58. This functionproduces a horizintal graph that shows the
  59. percentage of your total user base for 12 age groups. The
  60. youngest group lists users for ages 11 - 20, but users under 11
  61. years of age will be included in that group.
  62.  
  63.  
  64. To create this graph type EPROMISC /AGE. The resulting ANS/ASC
  65. files will be placed in the textfiles directory as specified in
  66. your EZYPRO configuration.
  67.  
  68.  
  69. The maximum percentage of any category is 35%.
  70.  
  71. /CLEAN
  72.  
  73. Depending on how you delete your file areas you may have area
  74. headers lying around that are just taking up space (albeit, only
  75. a little space). This function searches through your Ezycom file
  76. base defintions and locates all area headers for areas that are
  77. no longer defined and asks you if you wish to delete them.
  78.  
  79. This function displays the area numbers and names as it reads
  80. the file base definitions. When it find a header for an
  81. undefined area you are asked "Found but path is blank  --->
  82. Delete it? (Y/n/a):"
  83.  
  84. The options are Y = Yes, delete the header, N = No leave it
  85. alone, A = Abort the run. 
  86.  
  87. To Run this function type EPROMISC /CLEAN.
  88.  
  89.  
  90. /DIRS
  91.  
  92. This function creates a list of directories from your Ezycom
  93. file base and writes those names to a file called FILES.DIR
  94. which can be used by other programs such as mailers for a list
  95. of freqable directories.
  96.  
  97. To run this function type EPROMISC /DIRS
  98.  
  99.  
  100. /DOOR
  101.  
  102. This function creates the door usage graph. In order for this
  103. function to work you must be collecting door usage data using
  104. the EZYTDOOR program (and its /P command). 
  105.  
  106. Two files are created.. DOORGRPH.ANS and DOORGRPH.ASC, and these
  107. are placed in your text files directory as specified in your
  108. EZYPRO configuration.
  109.  
  110. The graph is a scalable graph. The door with the highest number
  111. of calls is set as the maximum margin for the graph and all
  112. other doors are scaled against that maximum. 
  113.  
  114. /ECHOLIST
  115.  
  116. You can abbreviate this one to /ECHO.
  117.  
  118. Use this function to create a list of message areas defined on
  119. your Ezycom system. Two files are created. The first is a sorted
  120. list of message area tags. The second is a list of tags and
  121. descriptions. 
  122.  
  123. The first list is useful for downlinks who want to perform area
  124. maintenance, and the second list gives your downlinks an idea of
  125. the message areas topic on your system.
  126.  
  127. The file name is configured via the EZYPRO configuration
  128. program and the extensions .TAG and .LST are added to the files.
  129. If you used the file name of ECHOLIST then the two files that
  130. are created would be called ECHOLIST.TAG and ECHOLIST.LST.
  131.  
  132. EZYPRO also provides the ability to exclude mesaage areas from
  133. the output list by placing the tag names in another file that
  134. you define in the EZYPRO configuration program. For example,
  135. you might call your file EXCLUDE (the extesnion .CTL is
  136. automatically added to the end).  For example, you have an echo
  137. called NEW_ECHO and you don't want that echo listed in your
  138. output files. Simply added the line NEW_ECHO to the Ascii file
  139. and it will be omitted.
  140.  
  141. /FBCLEAN
  142.  
  143. File base clean up is an extension to the facilities in Ezycom
  144. file area definitions. Its purpose is simply to give you more
  145. flexibility with file base management.
  146.  
  147. EZYPRO allows you to specify global controls or controls per
  148. area. The minimum downloads and oldest file parameters on the
  149. first page of the configuration program are the global override
  150. controls. If set to zero the individual area controls are used.
  151.  
  152.  
  153. Ezycom provides for deleting files that arrived nn days ago,
  154. have not been downloaded in nn days or files that are nn days
  155. old. EZYPRO adds the ability to download files that have been
  156. downloaded fewer than a specified number of times in a given
  157. period and provides the ability to move the files to another
  158. directory for checking prior to being deleted.
  159.  
  160. This function also provides a test function which allows you to
  161. determine the impact of running a filebase cleanup given the
  162. controls you have specified and provides extensive file base
  163. analysis information such as amount of disk space regained from
  164. the cleanup process.
  165.  
  166. When file moving is enabled (registered version only), the
  167. /FBCLEAN function will watch disk space as it moves the files.
  168. If you run out of space on the drive where files are being moved
  169. to the process will terminate.
  170.  
  171. The /FBCLEAN process in EZYPRO does not use the date of the
  172. file as specified in the filebase, as this may be wrong (If you
  173. don't run EZYFILE -UPDATE after changing or touching a file), so
  174. the real file date is used.
  175.  
  176. Results of the /FBCLEAN process are written to a file called
  177. EYCLEAN.RES.
  178.  
  179. Please note that at the current beta release this function has
  180. been disabled whilst the function is re-written from scratch.
  181.  
  182. /FDA, /IMA
  183.  
  184. These functions both do the same thing, except that one works
  185. with the Frontdoor log file, the other works with the Intermail
  186. Log file.
  187.  
  188. Two files are created by this function. The first is a summary
  189. file called MAILSUM.TXT, which contains a summary list of
  190. transfers from specified addresses. The second file is called
  191. MAILNODE.TXT and is the list of transactions for the requested
  192. address. All transactions from the log file for the address are
  193. listed individually and summarised at the end with total number
  194. and size of file sent and received and an average CPS rate for
  195. those transfers.
  196.  
  197. EPROMISC /xMA requires one other parameter: The address to be
  198. reported on. For example, you would run this function thus...
  199.  
  200.     EPROMISC /IMA 3:639/252 or      EPROMISC /FDA 3:639/252
  201.  
  202. You will need to run this function for each address you wish to
  203. analyse.
  204.  
  205.  
  206. On my system I have my maintenance set up to move my log files
  207. on the first of each month. After that some batch commands are
  208. run to analyse the previous months transactions for each of the
  209. downlinks from my system. Since I run two lines this process is
  210. repeated for each line I run and I then end up with a report
  211. that I could send to each node of transfers for the previous
  212. month.
  213.  
  214. I also have a summary file listing the totals for each address
  215. for the previous month which quickly enables me to identify
  216. where the flow of files and mail is going. This simplfies set up
  217. of polling schedules, identifying who takes what, which nodes
  218. are getting good connects (eg high CPS rates), how much data is
  219. flowing through my system, and on which lines so I have a clear
  220. picture of how my system is performing.
  221.  
  222. With that knowledge I can do capacity planning, availability and
  223. recovery planning and be reasonably confident that when I go
  224. away the system will keep on going (provided I acted upon what I
  225. was being presented in the analysis reports). Well, except for
  226. the large volume of corrupt files that typically come from a
  227. very few file areas on the assorted file backbones.
  228.  
  229. Currently, they expect to find the log file in the current
  230. directory (Either you are logged into the directory where they
  231. files are or they are in the same directory as the EPROMISC.EXE
  232. program.
  233.  
  234.  
  235. /FDSTRIP, /IMSTRIP
  236.  
  237. These functions are similar to the /IMA and /FDA functions in
  238. that both /FDSTRIP and /IMSTRIP do the same thing: They trim the
  239. Frontdoor and Intermail log files to the number of days you
  240. specified on EZYPRO' configuration. They look for the log
  241. files FD.LOG and IM.LOG respectively.
  242.  
  243. Currently, they expect to find the log file in the current
  244. directory (Either you are logged into the directory where they
  245. files are or they are in the same directory as the EPROMISC.EXE
  246. program.
  247.  
  248. Future versions of EZYPRO will provide the ability to specify
  249. the file name on the command line.
  250.  
  251.  
  252. /FILDUMP
  253.  
  254. This function creates an Ascii file that contain a list of all
  255. available file area defintions on your BBS. Undefined areas are
  256. listed as "-" in the area name.
  257.  
  258.  
  259.  
  260. The output file is called EZYTFILE.DMP and is created in your
  261. EZYPRO directory.
  262.  
  263.  
  264. /INIT
  265.  
  266. The /INIT function is used to generate fresh history files for
  267. the EZYPRO history generation functions. It needs to be run
  268. whenever you increase the number of file or message areas on
  269. your system. 
  270.  
  271. In preference to increasing those items, set the maximum number
  272. of file and message areas on your BBS to the highest number you
  273. think you will ever be likely to use.
  274.  
  275. The history file generated are called MSGBASE.HST, FILEBASE.HST 
  276. and EZYPRO.HST. The size of the files is dependant on the
  277. reterntion period you specified on the control file (1 - 12
  278. months), and the number of file and message areas on your
  279. system. The following calculations are used to determine the
  280. file sizes...
  281.  
  282.  
  283. Filebase                                             Msgbase
  284.  
  285. Number of areas x (months x 31) x  20   Number of areas x (monthsx 31) x 15
  286.  
  287. Eg. 400 areas, 12 months retention      Eg 1536 areas, 12 months retention
  288. =       400 x (12 x 31) x 20                =       1536 x (12 x 31) x 15
  289. =       2976000bytes                        =       8570880 bytes
  290. =       2976 kb                             =       8570 kb
  291.  
  292.  
  293. /LIST
  294.  
  295. Ezycom currently does not provide an automated method of sending
  296. echoarea lists to other systems. The EZYNET -U function can be
  297. used to send a message to a specific address, but what about the
  298. situation where you want to do this for every connected node and
  299. on a regular, periodic basis.
  300.  
  301.  
  302.  
  303. That is what the /LIST function does. 
  304.  
  305. Using a control file called EZYPRO.NOT (short for notify),
  306. EPROMISC will send such messages to all listed systems on the
  307. date listed in the control file.
  308.  
  309. The control file can be up to 512 lines long and may contain
  310. comments, addresses and a single line which specifies on what
  311. day of the month messages are sent.
  312.  
  313. The first non-comment line of the control file must be a two
  314. digit number specifying the day to send messages. 01, 10, 20 and
  315. 25 are all examples of valid values. 
  316.  
  317. Comments are any lines preceeded by a semi colon (;).
  318.  
  319. All other lines are considered to be addresses. These addresses
  320. are NOT checked for validity. If you get them wrong you will get
  321. no message telling you that they are wrong.  All addresses must
  322. be full 3D or 4D addresses (eg 3:639/252 and 3:639/252.100 are
  323. both valid addresses). Do not include domain names on your
  324. addresses (eg @fidonet).
  325.  
  326. EPROMISC first checks to see if the day of the month in the
  327. control file matches today. If so, it reads in all the addresses
  328. then simply calls EZYNET -U with the address appended and EZYNET
  329. does the rest.
  330.  
  331.  
  332. /MBCLEAN
  333.  
  334. This function is similar to the /FBCLEAN function in principle
  335. (that it, it cleans up your message base).It is designed to
  336. physically remove message areas from your system that have no
  337. traffic for a specified period of  days. The number of days is
  338. specified in the configuration file.
  339.  
  340. To use this function you must have been using the history
  341. generation functions as this is how /MBCLEAN determines that
  342. there has been no flow in the area.
  343.  
  344. The message area must not only have had no traffic, but it must
  345. have no messages in it and have no connected systems other than
  346. the uplink system.
  347.  
  348. This function will also report all areas on your system that
  349. have no messages, have had no flow but do have connected systems
  350. so that you can make a decision on whjat you are going to do
  351. with the area.
  352.  
  353. /MSGDUMP
  354.  
  355. This function creates an Ascii file that contain a list of all
  356. available messge area defintions on your BBS. Undefined areas
  357. are listed as "-" in the area name.
  358.  
  359.  
  360.  
  361. The output file is called EZYTMSG.DMP and is created in your
  362. EZYPRO directory.
  363.  
  364. /NEWS
  365.  
  366. Ezycom provides the ability to display a news file (which must
  367. be called NEWS.ANS/.ASC), after a user logs on but before the
  368. top menu is displayed.
  369.  
  370. EZYPRO provides the ability to create news files (of any name,
  371. but Ezycom looks only for NEWS). You can use the editor in
  372. Ezyshell to edit your source news file, or any other text editor.
  373.  
  374. This first line of this source file must be in the format xx ;
  375. yy ; zz, where xx =  the header color, yy =  border color and zz
  376. = text color.  Here is a sample of the news header...
  377.  
  378.  
  379.  
  380.         ------------------------------
  381.  -----------|    This is a test header   |----------------| 24/06/96 |----
  382.         ------------------------------
  383.  
  384. The header color refers to the text inside the box, the border
  385. color is the box color. The text color is the color of the word
  386. below the header (your actual message).
  387.  
  388. The EZYPRO news function also allows for comments in your news
  389. file. Preceed lines with a semi colon and they will be treated
  390. as comments.
  391.  
  392. A comment file may be up to 512 lines long.
  393.  
  394. After editing your source news file use EPROMISC /NEWS to
  395. generate the .ANS and .ASC news files, which will be placed in
  396. the text files directory specified in the configuration.
  397.  
  398. The date must be entered as DD-MM-YY, or by uing the macro
  399. *TODAY. *TODAY means use the current system date when creating
  400. the output news file, and will always use the system date
  401. whenever the news file is recreated. Using such a date will
  402. result in an article always being current and ineligible for
  403. purging.
  404.  
  405. /POINT
  406.  
  407. One of EZYPRO' many user screens is the FPOINTS screens. Two
  408. screens are created (.ANS and .ASC), and placed in your text
  409. files directory.
  410.  
  411. This function simply creates a screen containing a list of 15
  412. users with the most file points accrued, in descending order.
  413.  
  414. /PURGE
  415.  
  416. With the ability to create news files some means of managing
  417. your news files is also needed. 
  418.  
  419. The configuration program provided a means of entering a
  420. filename, and below that is a parameter which specifies the
  421. retention of the news articles.
  422.  
  423. A value of 0 disables purging, so articles will always stay on
  424. the .ANS./.ASC screens. If you used the *TODAY macro when
  425. specifying a date on the news article that article will never be
  426. deleted, as today is never greater than the number of days
  427. specified for the retention.
  428.  
  429. The allowable range for the purge function is 0 to 255 days.
  430.  
  431. To purge the news articles type EPROMISC /PURGE.
  432.  
  433. Once the purge has completed EPROMISC will automatically run
  434. EPROMISC /NEWS to regenerate the .ANS/.ASC output files.
  435.  
  436.  
  437. /SCAN [Not currently available]
  438.  
  439. This function produces a filebase analysis report that shows the
  440. following:
  441.  
  442.     The number of users at each of your security levels.
  443.     The number of bytes transferrable at a dozen modem speeds based
  444.     on 100% efficiency
  445.     The smallest, average size and largest files on your system, 
  446.     by area
  447.     The percentage of users at each security level that could
  448.     download the smallest, average size and larget files per area
  449.     The number of downloads per area vs the total number of and size
  450.     of files in those areas
  451.     The percentage of your total file base per area
  452.     How well each area is performing (Large areas with few downloads
  453.     are said to be poor performers).
  454.  
  455. Having this information simplifies file base management. It
  456. enables you to determine which areas on your BBS are just
  457. wasting disk space. Typically you'll find games and Windows 95
  458. areas are good performers, whilst something like missing persons
  459. and chess base type areas are dead.
  460.  
  461. /STATn
  462.  
  463. The /STAT function produces 2 screens containing the top 15
  464. users sorted in one of five sequences. The data on the screens
  465. is the same, but the actuall contents (the users that are
  466. listed), will be dependant upon which of the 5 sequences you
  467. select. The available sequences are...
  468.  
  469.     1.      Kilobytes uploaded
  470.     2.      Kilobytes downloaded  (default if no sequence requested).
  471.     3.      Number of calls
  472.     4.      Number of messages posted
  473.     5.      Number of file points accrued.
  474.  
  475. /TRIM
  476.  
  477. This function trims your Ezybest log file (not your debug file).
  478. The number of days to retain is specified on the configuration
  479. file. 
  480.  
  481. The EZYPRO log file typically grows at around 1 - 2 kb per
  482. day, so a retention of 21 (three weeks), will give you, at most,
  483. a log file 45 kb in size.
  484.  
  485. The log file is expected to be found in the log file directory
  486. as specified on page two of the configuration program. 
  487.  
  488. /U=<user>
  489.  
  490. EZYPRO provides the ability to scan your user base and locate
  491. all files uploaded by <user>. A file called UPLDLIST.DAT is
  492. created in your EZYPRO directory which contains list of all
  493. files uploaded by the named user. You can't view this file with
  494. a text editor. You need to use either EPROMISC /VIEW (view
  495. online), or EPROMISC /UPEXPORT (create readable text file).
  496.  
  497. Typically the scan of your file base will take around 30 seconds
  498. per 400 areas.
  499.  
  500. The user name should not have spaces replaced with underscores.
  501. Eg PHILLIP MORGAN is valid for this function whereas
  502. PHILLIP_MORGAN is not.
  503.  
  504. /UPEXPORT
  505.  
  506. After creating a list of files uploaded by a user
  507. (UPLDLIST.DAT), you can create a plain ascii file that contains
  508. that list that you can view yourself or send to the user who
  509. uploaded the files.
  510.  
  511. For example, I use a questionaire to run a batch file that
  512. passes the user name to EPROMISC /U=<user> and then runs
  513. /UPEXPORT to convert the results to an ascii file and then fires
  514. up a menu type 48 to download the file. In this fashion a user
  515. can download a list of files they have uploaded to the BBS.
  516.  
  517. /VIEW
  518.  
  519. After creating a list of files uploaded by a user
  520. (UPLDLIST.DAT), you can view the list of uploaded files by using
  521. the EPROMISC /VIEW function. 
  522.  
  523. The screen shows you the users name, the total number files
  524. uploaded. The file name, area it currently resides in, how many
  525. times it has been downloaded, size and file date are displayed
  526. in the list.
  527.  
  528. Press SPACE to progress through the list if the user has
  529. uploaded more than 15 files.  When the end of the list is
  530. reached press HOME to go to the top of the list. Press ESC at
  531. any time to exit the view function.
  532.  
  533. ----------------------------------------------------------------------------                                   
  534. ----------------------------------------------------------------------------                                   
  535.                  
  536.                  
  537.                   SAMPLE AGE GRAPH                                 
  538.                   ----------------    
  539.                  
  540.                  
  541.                  Age Graph 
  542. ----------------------------------------------------------------------------  
  543.     
  544.     11 - 15 |________ 
  545.     16 - 20 |____________________________________________ 
  546.     21 - 25 |____________________________________________________ 
  547.     26 - 30 |__________________________ 
  548.     31 - 35 |____________________ 
  549.     36 - 40 |__________________ 
  550.     41 - 45 |__________________ 
  551.     46 - 50 |________ 
  552.     51 - 55 |__ 
  553.     56 - 60 |____ 
  554.     61 - 65 | 
  555.     66 - 70 |        
  556.         +-------------------------------------------------------+
  557.         10        15        20         25         30           35                                
  558.                      Percentage of userbase
  559.